<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilsecure: XilSecure Mailbox APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilsecure
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xsecure__mailbox__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilSecure Mailbox APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6ac5f0da32dd8fb5fcd15a7e65b492bb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox</a> (XMailbox *MailboxPtr, u32 *MsgPtr, u32 MsgLen)</td></tr>
<tr class="memdesc:ga6ac5f0da32dd8fb5fcd15a7e65b492bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to the target module and gets the response from it.  <a href="#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">More...</a><br/></td></tr>
<tr class="separator:ga6ac5f0da32dd8fb5fcd15a7e65b492bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga14ac66445aa924c4c0bd9b91b9744af9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__mailbox__apis.html#ga14ac66445aa924c4c0bd9b91b9744af9">XSecure_ClientInit</a> (XSecure_ClientInstance *const InstancePtr, XMailbox *const MailboxPtr)</td></tr>
<tr class="memdesc:ga14ac66445aa924c4c0bd9b91b9744af9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the instance of mailbox.  <a href="#ga14ac66445aa924c4c0bd9b91b9744af9">More...</a><br/></td></tr>
<tr class="separator:ga14ac66445aa924c4c0bd9b91b9744af9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga14ac66445aa924c4c0bd9b91b9744af9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_ClientInit </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *const&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XMailbox *const&#160;</td>
          <td class="paramname"><em>MailboxPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the instance of mailbox. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">MailboxPtr</td><td>Pointer to the mailbox instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On successful initialization</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Set XMailbox instance provided by the user to client library instance by validating whether provided client instance is not NULL.</p>

<p>Referenced by <a class="el" href="xilsecure__versal__ecdsa__client__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6ac5f0da32dd8fb5fcd15a7e65b492bb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_ProcessMailbox </td>
          <td>(</td>
          <td class="paramtype">XMailbox *&#160;</td>
          <td class="paramname"><em>MailboxPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to the target module and gets the response from it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">MailboxPtr</td><td>Pointer to XMailbox </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>Pointer to the payload message </td></tr>
    <tr><td class="paramname">MsgLen</td><td>Length of the message</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS If the IPI send and receive is successful</li>
<li>XST_FAILURE If there is a failure</li>
<li>Response received from server</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Payload consists of API ID and call arguments to be written in IPI buffer </dd></dl>
<p>Send CDO to PLM through IPI. Return XST_FAILURE if sending data failed</p>
<p>Wait for IPI response from PLM with a timeout. If the timeout exceeds then error is returned otherwise it returns the status of the IPI response</p>

<p>Referenced by <a class="el" href="group__xsecure__kat__client__apis.html#ga406813136028273d32d55dc2dd9f91c7">XSecure_AesDecryptCmKat()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga074dbaf57b453f094f14c6b6c7aca964">XSecure_AesDecryptData()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga49114523757f3b39daf51876ba899e51">XSecure_AesDecryptFinal()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#gacea2fc49243f66d0b440a95d1bd6170f">XSecure_AesDecryptInit()</a>, <a class="el" href="group__xsecure__kat__client__apis.html#ga1eb14922f650174090f0fdca7345a517">XSecure_AesDecryptKat()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga3150fb8656509ac0217c44c9609776cc">XSecure_AesDecryptUpdate()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#gaa65c921632e25a29b33b883d85cf9058">XSecure_AesEncryptData()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga982cb284b765c652355d9f942798211b">XSecure_AesEncryptFinal()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga23f9b2bfaf978518d82c19d8331c9cb8">XSecure_AesEncryptInit()</a>, <a class="el" href="group__xsecure__kat__client__apis.html#gaff0e846438561c899db7c1ce4b00817c">XSecure_AesEncryptKat()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga162a8009f9d4983d841b517fe53d14c4">XSecure_AesEncryptUpdate()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga2c662c76ab7afdb97977628d81604ec1">XSecure_AesGmacUpdateAad()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga5336eb4fdbdbd4c48776776c4524653e">XSecure_AesKekDecrypt()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#gaa3c4b19232e0c5fa8cf14d69410e31e7">XSecure_AesKeyZero()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga1be5abccbec8cce45963a979c72828e1">XSecure_AesPerformOperation()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga92901f6856f8e7ea38caac86fb44e10b">XSecure_AesPerformOperationAndZeroizeKey()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga2149f38c111ed53eec28fc05ac1afb1e">XSecure_AesSetDpaCm()</a>, <a class="el" href="group__xsecure__aes__client__apis.html#ga056f80ac76299a3ed41102b9f21237e7">XSecure_AesWriteKey()</a>, <a class="el" href="group__xsecure__ecdsa__client__apis.html#ga623ff4e3a9216677e7b5abe2767790a8">XSecure_EllipticGenerateKey()</a>, <a class="el" href="group__xsecure__ecdsa__client__apis.html#ga640d4ab0cd1edb783d2d0a8c2af44ef5">XSecure_EllipticGenerateSign()</a>, <a class="el" href="group__xsecure__kat__client__apis.html#ga5e9df7a4b6b28b1827cf11be03a97e0d">XSecure_EllipticSignGenKat()</a>, <a class="el" href="group__xsecure__kat__client__apis.html#gaf5996378299f1f95c9a13592febad58a">XSecure_EllipticSignVerifyKat()</a>, <a class="el" href="group__xsecure__ecdsa__client__apis.html#ga4e7f8b3452f7f23b4591cc21f1806b54">XSecure_EllipticValidateKey()</a>, <a class="el" href="group__xsecure__ecdsa__client__apis.html#ga88eea76778dab99a54821e2117a3034e">XSecure_EllipticVerifySign()</a>, <a class="el" href="group__xsecure__ecdsa__client__apis.html#ga0e90d7253656c56458e39541009e4954">XSecure_GenSharedSecret()</a>, <a class="el" href="group__xsecure__helper__client__apis.html#ga34fb190dff4e61e8f39544f732a94edf">XSecure_KeyUnwrap()</a>, <a class="el" href="group__xsecure__helper__client__apis.html#ga9ab0a956262afa96bfebba076415aa8b">XSecure_ReleaseRsaKey()</a>, <a class="el" href="group__xsecure__kat__client__apis.html#gaec9500ffdf3138f3e71404a3bd955972">XSecure_RsaPrivateDecKat()</a>, <a class="el" href="group__xsecure__rsa__client__apis.html#gaad026ed28e47be9b59e0444deb3af85a">XSecure_RsaPrivateDecrypt()</a>, <a class="el" href="group__xsecure__kat__client__apis.html#ga7e00313e2e3f47bfb6dbc463889971c4">XSecure_RsaPublicEncKat()</a>, <a class="el" href="group__xsecure__rsa__client__apis.html#gaf2a6250efae11b0bdbfe22e6642dedf4">XSecure_RsaPublicEncrypt()</a>, <a class="el" href="group__xsecure__rsa__client__apis.html#ga8bdc7108615c89806dae54dd56f428d7">XSecure_RsaSignVerification()</a>, <a class="el" href="group__xsecure__sha__client__apis.html#ga08e726488222ad0ba91e822d90e97e1e">XSecure_Sha3Digest()</a>, <a class="el" href="group__xsecure__sha__client__apis.html#gad9611876471310e83eae5fc2ac640576">XSecure_Sha3Finish()</a>, <a class="el" href="group__xsecure__kat__client__apis.html#ga0743d577968e560b692122ab03e22d35">XSecure_Sha3Kat()</a>, <a class="el" href="group__xsecure__sha__client__apis.html#ga66d0db1bbf860bc2247297ce63f398a2">XSecure_Sha3Update()</a>, <a class="el" href="group__xsecure__trng__client__apis.html#ga7d6de56d442c1199e990cfa01d45411c">XSecure_TrngGenerateRandNum()</a>, and <a class="el" href="group__xsecure__kat__client__apis.html#ga7b74e15ff3cab4a891179ef46efe576f">XSecure_TrngKat()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
